<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: TunecoreDirect::Album</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">TunecoreDirect::Album</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../files/lib/tunecore_direct/album_rb.html">
                lib/tunecore_direct/album.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                TunecoreDirect::Base
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
Represents an individual TuneCore <a href="Album.html">Album</a>. Each
album belongs to a Person and has one or more <a href="Song.html">Song</a>
objects attached to it. To attach artwork to the <a
href="Album.html">Album</a> you should place the <a
href="Artwork.html">Artwork</a> file on Amazon S3 and provide the S3
location in the artwork_s3_url accessor. You can upload the artwork file
using !TuneCore&#8216;s web-based upload tool or you can use a 3rd party S3
interface such as the <a
href="http://developer.amazonwebservices.com/connect/entry.jspa?externalID=135">Amazon_S3_Library_for_REST_in_Ruby</a>.
</p>
<p>
Stores should be defined using the following abbreviations, seperated by
commas: iTunesUS iTunesAU iTunesCA iTunesEU iTunesJP iTunesUK RhapsodyRH
MusicNet Napster eMusic Amazon Lala
</p>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000006">create</a>&nbsp;&nbsp;
      <a href="#M000011">finalize</a>&nbsp;&nbsp;
      <a href="#M000005">from_xml_element</a>&nbsp;&nbsp;
      <a href="#M000007">get</a>&nbsp;&nbsp;
      <a href="#M000008">get_all</a>&nbsp;&nbsp;
      <a href="#M000013">is_taken_down?</a>&nbsp;&nbsp;
      <a href="#M000004">new</a>&nbsp;&nbsp;
      <a href="#M000010">song_count</a>&nbsp;&nbsp;
      <a href="#M000009">songs</a>&nbsp;&nbsp;
      <a href="#M000012">takedown</a>&nbsp;&nbsp;
      <a href="#M000014">upload_url</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->
    <div id="includes">
      <h3 class="section-bar">Included Modules</h3>

      <div id="includes-list">
        <span class="include-name">TunecoreDirect</span>
      </div>
    </div>

    <div id="section">





    <div id="attribute-list">
      <h3 class="section-bar">Attributes</h3>

      <div class="name-list">
        <table>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">album_id</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">artist_name</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">artwork</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">artwork_s3_id</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">c_copyright</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">errors</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">label_name</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">name</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">orig_release_date</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">p_copyright</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">parental_advisory</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">person_id</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">primary_genre</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">recording_location</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">sale_date</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">secondary_genre</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">state</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">stores</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">takedown_at</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">xml</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        </table>
      </div>
    </div>
      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000005" class="method-detail">
        <a name="M000005"></a>

        <div class="method-heading">
          <a href="Album.src/M000005.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000005.html');return false;">
          <span class="method-name">from_xml_element</span><span class="method-args">( album_element)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Creates an <a href="Album.html">Album</a> object from a Rexml:Element
</p>
        </div>
      </div>

      <div id="method-M000007" class="method-detail">
        <a name="M000007"></a>

        <div class="method-heading">
          <a href="Album.src/M000007.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000007.html');return false;">
          <span class="method-name">get</span><span class="method-args">(album_id)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns an <a href="Album.html">Album</a>
</p>
        </div>
      </div>

      <div id="method-M000008" class="method-detail">
        <a name="M000008"></a>

        <div class="method-heading">
          <a href="Album.src/M000008.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000008.html');return false;">
          <span class="method-name">get_all</span><span class="method-args">(person_id=nil)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns all your albums. If a person_id is specified it will return only
albums for that person.
</p>
        </div>
      </div>

      <div id="method-M000004" class="method-detail">
        <a name="M000004"></a>

        <div class="method-heading">
          <a href="Album.src/M000004.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000004.html');return false;">
          <span class="method-name">new</span><span class="method-args">(options = {})</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000012" class="method-detail">
        <a name="M000012"></a>

        <div class="method-heading">
          <a href="Album.src/M000012.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000012.html');return false;">
          <span class="method-name">takedown</span><span class="method-args">(album_id)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Takes down an album from the stores
</p>
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000006" class="method-detail">
        <a name="M000006"></a>

        <div class="method-heading">
          <a href="Album.src/M000006.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000006.html');return false;">
          <span class="method-name">create</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Creates a <a href="Album.html#M000004">new</a> album
</p>
        </div>
      </div>

      <div id="method-M000011" class="method-detail">
        <a name="M000011"></a>

        <div class="method-heading">
          <a href="Album.src/M000011.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000011.html');return false;">
          <span class="method-name">finalize</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Once you call <a href="Album.html#M000011">Album#finalize</a> the album
will be queued for delivery to the stores. After you call <a
href="Album.html#M000011">finalize</a> you can no longer make changes to
the <a href="Album.html">Album</a>. All the <a
href="Album.html#M000009">songs</a> should be created and media assets for
the <a href="Album.html">Album</a> should be uploaded to S3.
</p>
        </div>
      </div>

      <div id="method-M000013" class="method-detail">
        <a name="M000013"></a>

        <div class="method-heading">
          <a href="Album.src/M000013.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000013.html');return false;">
          <span class="method-name">is_taken_down?</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000010" class="method-detail">
        <a name="M000010"></a>

        <div class="method-heading">
          <a href="Album.src/M000010.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000010.html');return false;">
          <span class="method-name">song_count</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns the number of <a href="Album.html#M000009">songs</a> that have been
created for this album
</p>
        </div>
      </div>

      <div id="method-M000009" class="method-detail">
        <a name="M000009"></a>

        <div class="method-heading">
          <a href="Album.src/M000009.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000009.html');return false;">
          <span class="method-name">songs</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns an array that contains every <a href="Song.html">Song</a> in this
<a href="Album.html">Album</a>
</p>
        </div>
      </div>

      <div id="method-M000014" class="method-detail">
        <a name="M000014"></a>

        <div class="method-heading">
          <a href="Album.src/M000014.html" target="Code" class="method-signature"
            onclick="popupCode('Album.src/M000014.html');return false;">
          <span class="method-name">upload_url</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>